home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Misc Servers / Zope.exe / AQUEDUCT.PY < prev    next >
Encoding:
Python Source  |  2000-06-15  |  16.0 KB  |  469 lines
  1. 7##############################################################################
  2. # 
  3. # Zope Public License (ZPL) Version 1.0
  4. # -------------------------------------
  5. # 
  6. # Copyright (c) Digital Creations.  All rights reserved.
  7. # 
  8. # This license has been certified as Open Source(tm).
  9. # 
  10. # Redistribution and use in source and binary forms, with or without
  11. # modification, are permitted provided that the following conditions are
  12. # met:
  13. # 
  14. # 1. Redistributions in source code must retain the above copyright
  15. #    notice, this list of conditions, and the following disclaimer.
  16. # 
  17. # 2. Redistributions in binary form must reproduce the above copyright
  18. #    notice, this list of conditions, and the following disclaimer in
  19. #    the documentation and/or other materials provided with the
  20. #    distribution.
  21. # 
  22. # 3. Digital Creations requests that attribution be given to Zope
  23. #    in any manner possible. Zope includes a "Powered by Zope"
  24. #    button that is installed by default. While it is not a license
  25. #    violation to remove this button, it is requested that the
  26. #    attribution remain. A significant investment has been put
  27. #    into Zope, and this effort will continue if the Zope community
  28. #    continues to grow. This is one way to assure that growth.
  29. # 
  30. # 4. All advertising materials and documentation mentioning
  31. #    features derived from or use of this software must display
  32. #    the following acknowledgement:
  33. # 
  34. #      "This product includes software developed by Digital Creations
  35. #      for use in the Z Object Publishing Environment
  36. #      (http://www.zope.org/)."
  37. # 
  38. #    In the event that the product being advertised includes an
  39. #    intact Zope distribution (with copyright and license included)
  40. #    then this clause is waived.
  41. # 
  42. # 5. Names associated with Zope or Digital Creations must not be used to
  43. #    endorse or promote products derived from this software without
  44. #    prior written permission from Digital Creations.
  45. # 
  46. # 6. Modified redistributions of any form whatsoever must retain
  47. #    the following acknowledgment:
  48. # 
  49. #      "This product includes software developed by Digital Creations
  50. #      for use in the Z Object Publishing Environment
  51. #      (http://www.zope.org/)."
  52. # 
  53. #    Intact (re-)distributions of any official Zope release do not
  54. #    require an external acknowledgement.
  55. # 
  56. # 7. Modifications are encouraged but must be packaged separately as
  57. #    patches to official Zope releases.  Distributions that do not
  58. #    clearly separate the patches from the original work must be clearly
  59. #    labeled as unofficial distributions.  Modifications which do not
  60. #    carry the name Zope may be packaged in any form, as long as they
  61. #    conform to all of the clauses above.
  62. # 
  63. # 
  64. # Disclaimer
  65. # 
  66. #   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
  67. #   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  68. #   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  69. #   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
  70. #   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  71. #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  72. #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  73. #   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  74. #   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  75. #   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  76. #   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  77. #   SUCH DAMAGE.
  78. # 
  79. # 
  80. # This software consists of contributions made by Digital Creations and
  81. # many individuals on behalf of Digital Creations.  Specific
  82. # attributions are listed in the accompanying credits file.
  83. # 
  84. ##############################################################################
  85. __doc__='''Shared classes and functions
  86.  
  87. $Id: Aqueduct.py,v 1.40.18.1 2000/06/15 21:56:23 amos Exp $'''
  88. __version__='$Revision: 1.40.18.1 $'[11:-2]
  89.  
  90. import Globals, os
  91. from Globals import HTMLFile, Persistent
  92. import DocumentTemplate, DateTime, ts_regex,  regex, string
  93. import binascii, Acquisition
  94. DateTime.now=DateTime.DateTime
  95. from cStringIO import StringIO
  96. from OFS import SimpleItem
  97. from AccessControl.Role import RoleManager
  98. from DocumentTemplate import HTML
  99.  
  100. from string import strip, replace
  101.  
  102. dtml_dir=Globals.package_home(globals())
  103.  
  104. InvalidParameter='Invalid Parameter'
  105.  
  106.  
  107. class BaseQuery(Persistent, SimpleItem.Item,
  108.                 Acquisition.Implicit, RoleManager):
  109.  
  110.     def query_year(self): return self.query_date.year()
  111.     def query_month(self): return self.query_date.month()
  112.     def query_day(self): return self.query_date.day()
  113.     query_date=DateTime.now()
  114.     manage_options=()
  115.  
  116.     def quoted_input(self): return quotedHTML(self.input_src)
  117.     def quoted_report(self): return quotedHTML(self.report_src)
  118.  
  119.     MissingArgumentError='Bad Request'
  120.  
  121.     def _convert(self): self._arg=parse(self.arguments_src)
  122.  
  123.     def _argdata(self, REQUEST):
  124.  
  125.         r={}
  126.  
  127.         try: args=self._arg
  128.         except:
  129.             self._convert()
  130.             args=self._arg
  131.  
  132.         id=self.id
  133.         missing=[]
  134.  
  135.         for name in args.keys():
  136.             idname="%s/%s" % (id, name)
  137.             try:
  138.                 r[name]=REQUEST[idname]
  139.             except:
  140.                 try: r[name]=REQUEST[name]
  141.                 except:
  142.                     arg=args[name]
  143.                     try: r[name]=arg['default']
  144.                     except:
  145.                         try:
  146.                             if not arg['optional']: missing.append(name)
  147.                         except: missing.append(name)
  148.                     
  149.         if missing:
  150.             raise self.MissingArgumentError, missing
  151.  
  152.         return r
  153.  
  154.     _col=None
  155.     _arg={}
  156.  
  157. class Searchable(BaseQuery):
  158.  
  159.     def _searchable_arguments(self):
  160.  
  161.         try: return self._arg
  162.         except:
  163.             self._convert()
  164.             return self._arg
  165.  
  166.     def _searchable_result_columns(self): return self._col
  167.  
  168.     def manage_testForm(self, REQUEST):
  169.         """Provide testing interface"""
  170.         input_src=default_input_form(self.title_or_id(),
  171.                                      self._searchable_arguments(),
  172.                                      'manage_test')
  173.         return HTML(input_src)(self, REQUEST)
  174.  
  175.     def manage_test(self, REQUEST):
  176.         'Perform an actual query'
  177.         
  178.         result=self(REQUEST)
  179.         report=HTML(custom_default_report(self.id, result))
  180.         return apply(report,(self,REQUEST),{self.id:result})
  181.  
  182.     def index_html(self, URL1):
  183.         " "
  184.         raise 'Redirect', ("%s/manage_testForm" % URL1)
  185.  
  186. class Composite:    
  187.  
  188.     def _getquery(self,id):
  189.  
  190.         o=self
  191.         i=0
  192.         while 1:
  193.             __traceback_info__=o
  194.             q=getattr(o,id)
  195.             try:
  196.                 if hasattr(q,'_searchable_arguments'):
  197.                     try: q=q.__of__(self.aq_parent)
  198.                     except: pass
  199.                     return q
  200.             except: pass
  201.             if i > 100: raise AttributeError, id
  202.             i=i+1
  203.             o=o.aq_parent
  204.             
  205.     def myQueryIds(self):
  206.         return map(
  207.             lambda k, queries=self.queries:
  208.             {'id': k, 'selected': k in queries},
  209.             self.ZQueryIds())
  210.  
  211. def default_input_form(id,arguments,action='query',
  212.                        tabs=''):
  213.     if arguments:
  214.         items=arguments.items()
  215.         return (
  216.             "%s\n%s%s" % (
  217.                 '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">\n'
  218.                 '<html lang="en"><head><title>%s Input Data</title></head>\n'
  219.                 '<body bgcolor="#FFFFFF" link="#000099" vlink="#555555">\n%s\n'
  220.                 '<form action="<dtml-var URL2>/<dtml-var id>/%s" '
  221.                 'method="get">\n'
  222.                 '<h2>%s Input Data</h2>\n'
  223.                 'Enter query parameters:<br>'
  224.                 '<table>\n'
  225.                 % (id, tabs, action,id),
  226.                 string.joinfields(
  227.                     map(
  228.                         lambda a:
  229.                         ('<tr> <th>%s</th>\n'
  230.                          '     <td><input name="%s"\n'
  231.                          '                width=30 value="%s">'
  232.                          '     </td></tr>'
  233.                          % (nicify(a[0]),
  234.                             (
  235.                                 a[1].has_key('type') and
  236.                                 ("%s:%s" % (a[0],a[1]['type'])) or
  237.                                 a[0]
  238.                                 ),
  239.                             a[1].has_key('default') and a[1]['default'] or ''
  240.                             ))
  241.                         , items
  242.                         ),
  243.                 '\n'),
  244.                 '\n<tr><td colspan=2 align=center>\n'
  245.                 '<input type="SUBMIT" name="SUBMIT" value="Submit Query">\n'
  246.                 '<dtml-if HTTP_REFERER>\n'
  247.                 '  <input type="SUBMIT" name="SUBMIT" value="Cancel">\n'
  248.                 '  <INPUT NAME="CANCEL_ACTION" TYPE="HIDDEN"\n'
  249.                 '         VALUE="<dtml-var HTTP_REFERER>">\n'
  250.                 '</dtml-if>\n'
  251.                 '</td></tr>\n</table>\n</form>\n</body>\n</html>\n'
  252.                 )
  253.             )
  254.     else:
  255.         return (
  256.             '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">\n'
  257.             '<html lang="en"><head><title>%s Input Data</title></head>\n'
  258.             '<body bgcolor="#FFFFFF" link="#000099" vlink="#555555">\n%s\n'
  259.             '<form action="<dtml-var URL2>/<dtml-var id>/%s" '
  260.             'method="get">\n'
  261.             '<h2>%s Input Data</h2>\n'
  262.             'This query requires no input.<p>\n'
  263.             '<input type="SUBMIT" name="SUBMIT" value="Submit Query">\n'
  264.             '<dtml-if HTTP_REFERER>\n'
  265.             '  <input type="SUBMIT" name="SUBMIT" value="Cancel">\n'
  266.             '  <INPUT NAME="CANCEL_ACTION" TYPE="HIDDEN"\n'
  267.             '         VALUE="<dtml-var HTTP_REFERER>">\n'
  268.             '</dtml-if>\n'
  269.             '</td></tr>\n</table>\n</form>\n</body>\n</html>\n'
  270.             % (id, tabs, action, id)
  271.             )
  272.  
  273.  
  274. custom_default_report_src=DocumentTemplate.File(
  275.     os.path.join(dtml_dir,'customDefaultReport.dtml'))
  276.  
  277. def custom_default_report(id, result, action='', no_table=0,
  278.                           goofy=regex.compile('[^a-zA-Z0-9_]').search
  279.                           ):
  280.     columns=result._searchable_result_columns()
  281.     __traceback_info__=columns
  282.     heading=('<tr>\n%s        </tr>' %
  283.                  string.joinfields(
  284.                      map(lambda c:
  285.                          '          <th>%s</th>\n' % nicify(c['name']),
  286.                          columns),
  287.                      ''
  288.                      )
  289.                  )
  290.  
  291.     if no_table: tr, _tr, td, _td, delim = '<p>', '</p>', '', '', ',\n'
  292.     else: tr, _tr, td, _td, delim = '<tr>', '</tr>', '<td>', '</td>', '\n'
  293.  
  294.     row=[]
  295.     for c in columns:
  296.         n=c['name']
  297.         if goofy(n) >= 0: n='expr="_[\'%s]"' % (`'"'+n`[2:])
  298.         row.append('          %s<dtml-var %s%s>%s'
  299.                    % (td,n,c['type']!='s' and ' null=""' or '',_td))
  300.  
  301.     row=('     %s\n%s\n        %s' % (tr,string.joinfields(row,delim), _tr))
  302.  
  303.     return custom_default_report_src(
  304.         id=id,heading=heading,row=row,action=action,no_table=no_table)
  305.  
  306. def detypify(arg):
  307.     l=string.find(arg,':')
  308.     if l > 0: arg=arg[:l]
  309.     return arg
  310.  
  311. def decode(input,output):
  312.     while 1:
  313.         line = input.readline()
  314.         if not line: break
  315.         s = binascii.a2b_base64(line[:-1])
  316.         output.write(s)
  317.  
  318. def decodestring(s):
  319.         f = StringIO(s)
  320.         g = StringIO()
  321.         decode(f, g)
  322.         return g.getvalue()
  323.  
  324. class Args:
  325.     def __init__(self, data, keys):
  326.         self._data=data
  327.         self._keys=keys
  328.  
  329.     def items(self):
  330.         return map(lambda k, d=self._data: (k,d[k]), self._keys)
  331.  
  332.     def values(self):
  333.         return map(lambda k, d=self._data: d[k], self._keys)
  334.  
  335.     def keys(self): return list(self._keys)
  336.     def has_key(self, key): return self._data.has_key(key)
  337.     def __getitem__(self, key): return self._data[key]
  338.     def __setitem__(self, key, v): self._data[key]=v
  339.     def __delitem__(self, key): del self._data[key]
  340.     def __len__(self): return len(self._data)
  341.  
  342. def parse(text,
  343.           result=None,
  344.           keys=None,
  345.           unparmre=ts_regex.compile(
  346.               '\([\0- ]*\([^\0- =\"]+\)\)'),
  347.           parmre=ts_regex.compile(
  348.               '\([\0- ]*\([^\0- =\"]+\)=\([^\0- =\"]+\)\)'),
  349.           qparmre=ts_regex.compile(
  350.               '\([\0- ]*\([^\0- =\"]+\)="\([^"]*\)\"\)'),
  351.           ):
  352.  
  353.     if result is None:
  354.         result = {}
  355.         keys=[]
  356.  
  357.     __traceback_info__=text
  358.  
  359.     ts_results = parmre.match_group(text, (1,2,3))
  360.     if ts_results:
  361.         start, grps = ts_results
  362.         name=grps[1]
  363.         value={'default':grps[2]}
  364.         l=len(grps[0])
  365.     else:
  366.         ts_results = qparmre.match_group(text, (1,2,3))
  367.         if ts_results:
  368.                 start, grps = ts_results
  369.                 name=grps[1]
  370.                 value={'default':grps[2]}
  371.                 l=len(grps[0])
  372.         else:
  373.             ts_results = unparmre.match_group(text, (1,2))
  374.             if ts_results:
  375.                 start, grps = ts_results
  376.                 name=grps[1]
  377.                 l=len(grps[0])
  378.                 value={}
  379.             else:
  380.                 if not text or not strip(text): return Args(result,keys)
  381.                 raise InvalidParameter, text
  382.  
  383.  
  384.     lt=string.find(name,':')
  385.     if lt > 0:
  386.         value['type']=name[lt+1:]
  387.         name=name[:lt]
  388.  
  389.     result[name]=value
  390.     keys.append(name)
  391.  
  392.     return parse(text[l:],result,keys)
  393.  
  394. def quotedHTML(text,
  395.                character_entities=(
  396.                    ('&', '&'),
  397.                    ("<", '<' ),
  398.                    (">", '>' ),
  399.                    ('"', '"'))): #"
  400.  
  401.  
  402.     for re,name in character_entities:
  403.         text=replace(text,re,name)
  404.  
  405.     return text
  406.  
  407. def nicify(name):
  408.     name=replace(string.strip(name), '_',' ')
  409.     return string.upper(name[:1])+name[1:]
  410.  
  411. def decapitate(html, RESPONSE=None,
  412.                header_re=ts_regex.compile(
  413.                    '\(\('
  414.                           '[^\0- <>:]+:[^\n]*\n'
  415.                       '\|'
  416.                           '[ \t]+[^\0- ][^\n]*\n'
  417.                    '\)+\)[ \t]*\n\([\0-\377]+\)'
  418.                    ),
  419.                space_re=ts_regex.compile('\([ \t]+\)'),
  420.                name_re=ts_regex.compile('\([^\0- <>:]+\):\([^\n]*\)'),
  421.                ):
  422.  
  423.  
  424.     ts_results = header_re.match_group(html, (1,3))
  425.     if not ts_results: return html
  426.  
  427.     headers, html = ts_results[1]
  428.  
  429.     headers=string.split(headers,'\n')
  430.  
  431.     i=1
  432.     while i < len(headers):
  433.         if not headers[i]:
  434.             del headers[i]
  435.         else:
  436.             ts_results = space_re.match_group(headers[i], (1,))
  437.             if ts_results:
  438.                 headers[i-1]="%s %s" % (headers[i-1],
  439.                                         headers[i][len(ts_reults[1]):])
  440.                 del headers[i]
  441.             else:
  442.                 i=i+1
  443.  
  444.     for i in range(len(headers)):
  445.         ts_results = name_re.match_group(headers[i], (1,2))
  446.         if ts_reults:
  447.             k, v = ts_reults[1]
  448.             v=string.strip(v)
  449.         else:
  450.             raise ValueError, 'Invalid Header (%d): %s ' % (i,headers[i])
  451.         RESPONSE.setHeader(k,v)
  452.  
  453.     return html
  454.  
  455.  
  456. def delimited_output(results,REQUEST,RESPONSE):
  457.     delim=REQUEST['output-delimiter']
  458.     try: output_type=REQUEST['output-type']
  459.     except: output_type='text/plain'
  460.     RESPONSE.setHeader('content-type', output_type)
  461.     join=string.join
  462.     return "%s\n%s\n" % (
  463.         join(results.names(),delim),
  464.         join(map(lambda row, delim=delim, join=join:
  465.                  join(map(str,row),delim),
  466.                  results),
  467.              '\n')
  468.         )
  469.